Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(handbook): Add information about custom pre-staging environment #2886

Merged
merged 3 commits into from
Jan 7, 2025

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request adds information to the handobok on how to create customized pre-staging environment.

Related Issue(s)

Closes FlowFuse/flowfuse#4929

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 36%, saving 48.16 KB.

Filename Before After Improvement Visual comparison
src/handbook/images/screenshots/gh-pre-staging-workflow-inputs.png 133.88 KB 85.72 KB -36.0% View diff

1547 images did not require optimisation.


To create a customized pre-staging environment, please follow the steps below:
1. Publish the changes to the feature branch of the package you wish to test.
2. Create a feature branch in the `flowfuse/flowfuse` repository with changes that depend on the package from step 1.
Copy link
Contributor

@joepavitt joepavitt Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I follow this step? Can we be more explicit, i.e. with an example? Or are we simply saying here, create a feature branch in flowfuse/flowfuse - that's the actual requirement, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or are we simply saying here, create a feature branch in flowfuse/flowfuse - that's the actual requirement, right?

That is correct. However, I rewrote those first two steps. Hope it's more clear now.

@ZJvandeWeg ZJvandeWeg removed their request for review January 6, 2025 09:02
@ppawlowski ppawlowski requested a review from joepavitt January 7, 2025 09:56
@joepavitt joepavitt merged commit 0f2ca01 into main Jan 7, 2025
6 checks passed
@joepavitt joepavitt deleted the docs-handbook-custom-prestaging branch January 7, 2025 10:44
@joepavitt
Copy link
Contributor

Thanks @ppawlowski

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Describe how to run custom pre-staging environment
2 participants